NotificationProvider Xojo Plugin

DesktopNotificationProvider Control

NotificationProvider is a control to display in application notifications.

Not all notifications are worthy of a system notification, like for example when validating fields and other things.

The control supports

DesktopControl
   DesktopNotificationProvider

control DesktopNotificationProvider

Properties

ErrorColorBackground color for Error notifications.
ErrorImageSets custom image for Error notifications.
ErrorLightForegroundIf set to true then foreground of error notification will be in light color.
Handle (Inherited) Returns a handle to the control.
Index (Inherited) If the control is used in a control set, this specifies the control's index in the set.
InformationColorBackground color for information notifications.
InformationImageSets custom image for Information notifications.
InformationLightForegroundIf set to true then foreground of information notification will be in light color.
LastNotificationIdReturns id of last notification.
MacOSAnimateIf set to true then notifications will use macOS native animations when closing manually by click or when closing by timer.
NotificationWidthWidth of notifications or zero if wanting it full window in width.
PlacementSets or gets placement location of the notifications.
SuccessColorBackground color for Success notifications.
SuccessImageSets custom image for Success notifications.
SuccessLightForegroundIf set to true then foreground of success notification will be in light color.
WarningColorBackground color for warning notifications.
WarningImageSets custom image for Warning notifications.
WarningLightForegroundIf set to true then foreground of warning notification will be in light color.
Window (Inherited) The control's parent window.

Methods

ClearClears all notifications.
Close (Inherited) Closes a control.
NotifyPosts notification that has message.
NotifyPosts notification that has title and message.
NotifyPosts notification that has title, message and reference object.
RemoveRemoves notification by id.
RemoveRemoves notification by reference object.
TimedNotifyPosts timed notification that has message.
TimedNotifyPosts timed notification that has title, message and reference object.
TimedNotifyPosts timed notification that has title and message.

Events

ActionFires when the body of the notification is clicked.
ClosingThe control is about to close.
NotificationClosedThis event is fired when a notification closes, giving indication if it was closed by user or not.
OpeningThe control is about to be loaded. Use this event to initialize a control.

Enumerations

NotifyTypeEnum representing Notification types.
PlacementValuesPlacement values for the Placement property.

Constants

Version = 1.1

Note that if notifications fill the window then the oldest ones will be automatically dismissed to make space for new ones.

Notifications belong to the host Window. So if NotificationProvider is put in container control then its the host window that will end up displaying the notifications.

Supported Platforms:

  • macOS Intel 64 bit
  • macOS Apple Silicon
  • Windows 32 bit
  • Windows 64 bit
  • Windows ARM 64 bit
  • Linux 32 bit
  • Linux 64 bit
  • Linux ARM 32 bit
  • Linux ARM 64 bit